Skip to content

Improve docblocks #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 17, 2014
Merged

Improve docblocks #3

merged 6 commits into from
Jun 17, 2014

Conversation

bjori
Copy link
Contributor

@bjori bjori commented Jun 17, 2014

Couple of docblock and linting fixes.

@bjori
Copy link
Contributor Author

bjori commented Jun 17, 2014

@jmikola you wanna gives this a quick look?

@@ -45,7 +46,7 @@ public function getId()
}

/**
* @see Cursor::getServer()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When implementing an interface or overriding a method, I do this instead of copy/pasting. It's up to you.

Some projects use @inheritDoc, but I've had mixed results with it and this is more explicit, as any generator should create a hyperlink to the referenced doc block.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mmmh.
I'm using this data to create the extension skeleton. Not really keen on making a full fledged javadoc parser :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants